btez2.h File Reference

This file contains API for BT-EZ 2 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"

Go to the source code of this file.

Data Structures
struct	btez2_rsp_evt_packet_t
	BT-EZ 2 Click response/event packet object. More...
struct	btez2_t
	BT-EZ 2 Click context object. More...
struct	btez2_cfg_t
	BT-EZ 2 Click configuration object. More...

Macros
#define	BTEZ2_PACKET_CMD_ACTION   "/"
	BT-EZ 2 commands begin.
#define	BTEZ2_PACKET_CMD_SET   "S"
#define	BTEZ2_PACKET_CMD_GET   "G"
#define	BTEZ2_PACKET_CMD_PROFILE   "."
#define	BTEZ2_PACKET_RESPONSE   "@R"
#define	BTEZ2_PACKET_EVENT   "@E"
#define	BTEZ2_PACKET_PARAM_DELIMITER   ","
#define	BTEZ2_PACKET_END   "\r\n"
#define	BTEZ2_CMD_SYS_PING   "PING"
	BT-EZ 2 action commands.
#define	BTEZ2_CMD_SYS_REBOOT   "RBT"
#define	BTEZ2_CMD_SYS_DUMP   "DUMP"
#define	BTEZ2_CMD_SYS_STORE_CONFIG   "SCFG"
#define	BTEZ2_CMD_SYS_FACTORY_RESET   "RFAC"
#define	BTEZ2_CMD_SYS_QUERY_FW_VERSION   "QFV"
#define	BTEZ2_CMD_SYS_QUERY_UNIQUE_ID   "QUID"
#define	BTEZ2_CMD_SYS_QUERY_RANDOM_NUM   "QRND"
#define	BTEZ2_CMD_SYS_AES_ENCRYPT   "AESE"
#define	BTEZ2_CMD_SYS_AES_DECRYPT   "AESD"
#define	BTEZ2_CMD_SYS_WRITE_USER_DATA   "WUD"
#define	BTEZ2_CMD_SYS_READ_USER_DATA   "RUD"
#define	BTEZ2_CMD_SYS_FORCE_HIBERNATION   "SLEEP"
#define	BTEZ2_CMD_GAP_CONNECT   "C"
#define	BTEZ2_CMD_GAP_CANCEL_CONNECTION   "CX"
#define	BTEZ2_CMD_GAP_UPDATE_CONN_PARAMS   "UCP"
#define	BTEZ2_CMD_GAP_SEND_CONNUPDATE_RESP   "CUR"
#define	BTEZ2_CMD_GAP_DISCONNECT   "DIS"
#define	BTEZ2_CMD_GAP_ADD_WHITELIST_ENTRY   "WLA"
#define	BTEZ2_CMD_GAP_DELETE_WHITELIST_ENTRY   "WLD"
#define	BTEZ2_CMD_GAP_START_ADV   "A"
#define	BTEZ2_CMD_GAP_STOP_ADV   "AX"
#define	BTEZ2_CMD_GAP_START_SCAN   "S"
#define	BTEZ2_CMD_GAP_STOP_SCAN   "SX"
#define	BTEZ2_CMD_GAP_QUERY_PEER_ADDRESS   "QPA"
#define	BTEZ2_CMD_GAP_QUERY_RSSI   "QSS"
#define	BTEZ2_CMD_GAP_QUERY_WHITELIST   "QWL"
#define	BTEZ2_CMD_GAP_PHY_UPDATE   "UP"
#define	BTEZ2_CMD_SMP_QUERY_BONDS   "QB"
#define	BTEZ2_CMD_SMP_DELETE_BOND   "BD"
#define	BTEZ2_CMD_SMP_PAIR   "P"
#define	BTEZ2_CMD_SMP_QUERY_RANDOM_ADDRESS   "QRA"
#define	BTEZ2_CMD_SMP_SEND_PAIRREQ_RESP   "PR"
#define	BTEZ2_CMD_SMP_SEND_PASSKEYREQ_RESP   "PE"
#define	BTEZ2_CMD_PROTOCOL_PARSE_MODE   "PPM"
	BT-EZ 2 set/get commands.
#define	BTEZ2_CMD_PROTOCOL_ECHO_MODE   "PEM"
#define	BTEZ2_CMD_SYS_BT_ADDRESS   "BA"
#define	BTEZ2_CMD_SYS_SLEEP_PARAMS   "SLP"
#define	BTEZ2_CMD_SYS_TX_POWER   "TXP"
#define	BTEZ2_CMD_SYS_UART_PARAMS   "TU"
#define	BTEZ2_CMD_SYS_TRANSPORT   "T"
#define	BTEZ2_CMD_GAP_DEVICE_NAME   "DN"
#define	BTEZ2_CMD_GAP_DEVICE_APPEARANCE   "DA"
#define	BTEZ2_CMD_GAP_ADV_DATA   "AD"
#define	BTEZ2_CMD_GAP_SR_DATA   "SRD"
#define	BTEZ2_CMD_GAP_ADV_PARAMS   "AP"
#define	BTEZ2_CMD_GAP_SCAN_PARAMS   "SP"
#define	BTEZ2_CMD_GAP_CONN_PARAMS   "CP"
#define	BTEZ2_CMD_GAP_EXTENDED_ADV_DATA   "EAD"
#define	BTEZ2_CMD_GAP_EXTENDED_SR_DATA   "ERD"
#define	BTEZ2_CMD_SMP_PRIVACY_MODE   "PRV"
#define	BTEZ2_CMD_SMP_SECURITY_PARAMS   "SBP"
#define	BTEZ2_CMD_SMP_FIXED_PASSKEY   "FPK"
#define	BTEZ2_CMD_CYSPP_CHECK   "CYSPPCHECK"
	BT-EZ 2 profile commands.
#define	BTEZ2_CMD_CYSPP_START   "CYSPPSTART"
#define	BTEZ2_CMD_CYSPP_SET_PARAMS   "CYSPPSP"
#define	BTEZ2_CMD_CYSPP_GET_PARAMS   "CYSPPGP"
#define	BTEZ2_CMD_CYSPP_SET_CLIENT_HANDLES   "CYSPPSH"
#define	BTEZ2_CMD_CYSPP_GET_CLIENT_HANDLES   "CYSPPGH"
#define	BTEZ2_CMD_CYSPP_SET_PACKETIZATION   "CYSPPSK"
#define	BTEZ2_CMD_CYSPP_GET_PACKETIZATION   "CYSPPGK"
#define	BTEZ2_EVT_SYS_BOOT   "BOOT"
	BT-EZ 2 event commands.
#define	BTEZ2_EVT_SYS_ERROR   "ERR"
#define	BTEZ2_EVT_SYS_FACTORY_RESET_COMPLETE   "RFAC"
#define	BTEZ2_EVT_SYS_FACTORY_TEST_ENTERED   "TFAC"
#define	BTEZ2_EVT_SYS_DUMP_BLOB   "DBLOB"
#define	BTEZ2_EVT_GAP_WHITELIST_ENTRY   "WL"
#define	BTEZ2_EVT_GAP_ADV_STATE_CHANGED   "ASC"
#define	BTEZ2_EVT_GAP_SCAN_STATE_CHANGED   "SSC"
#define	BTEZ2_EVT_GAP_SCAN_RESULT   "S"
#define	BTEZ2_EVT_GAP_CONNECTED   "C"
#define	BTEZ2_EVT_GAP_DISCONNECTED   "DIS"
#define	BTEZ2_EVT_GAP_CONNECTION_UPDATE_REQUESTED   "UCR"
#define	BTEZ2_EVT_GAP_CONNECTION_UPDATED   "CU"
#define	BTEZ2_EVT_GAP_PHY_UPDATED   "PU"
#define	BTEZ2_EVT_SMP_BOND_ENTRY   "B"
#define	BTEZ2_EVT_SMP_PAIRING_REQUESTED   "P"
#define	BTEZ2_EVT_SMP_PAIRING_RESULT   "PR"
#define	BTEZ2_EVT_SMP_ENCRYPTION_STATUS   "ENC"
#define	BTEZ2_EVT_SMP_PASSKEY_DISPLAY_REQUESTED   "PKD"
#define	BTEZ2_EVT_SMP_PASSKEY_ENTRY_REQUESTED   "PKE"
#define	BTEZ2_EVT_CYSPP_STATUS   ".CYSPP"
#define	BTEZ2_PACKET_TYPE_EVENT   0
	BT-EZ 2 response and event flag settings.
#define	BTEZ2_PACKET_TYPE_RESPONSE   1
#define	BTEZ2_RSP_TIMEOUT_1000MS   1000
	BT-EZ 2 timeout settings.
#define	BTEZ2_CMD_TIMEOUT_5000MS   5000
#define	BTEZ2_WAIT_TIMEOUT_5S   5
#define	BTEZ2_WAIT_TIMEOUT_INFINITE   0
#define	BTEZ2_CMD_CODE_BUFFER_SIZE   20
	BT-EZ 2 driver buffer size.
#define	BTEZ2_PAYLOAD_BUFFER_SIZE   200
#define	BTEZ2_TX_DRV_BUFFER_SIZE   200
#define	BTEZ2_RX_DRV_BUFFER_SIZE   500
#define	BTEZ2_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	btez2_return_value_t { BTEZ2_OK = 0 , BTEZ2_ERROR = -1 , BTEZ2_ERROR_TIMEOUT = -2 , BTEZ2_ERROR_CMD = -3 }
	BT-EZ 2 Click return value data. More...

Functions
void	btez2_cfg_setup (btez2_cfg_t *cfg)
	BT-EZ 2 configuration object setup function.
err_t	btez2_init (btez2_t *ctx, btez2_cfg_t *cfg)
	BT-EZ 2 initialization function.
err_t	btez2_generic_write (btez2_t *ctx, uint8_t *data_in, uint16_t len)
	BT-EZ 2 data writing function.
err_t	btez2_generic_read (btez2_t *ctx, uint8_t *data_out, uint16_t len)
	BT-EZ 2 data reading function.
void	btez2_set_rst_pin (btez2_t *ctx, uint8_t state)
	BT-EZ 2 set RST pin function.
void	btez2_reset_device (btez2_t *ctx)
	BT-EZ 2 reset device function.
void	btez2_set_cts_pin (btez2_t *ctx, uint8_t state)
	BT-EZ 2 set CTS pin function.
uint8_t	btez2_get_rts_pin (btez2_t *ctx)
	BT-EZ 2 get RTS pin function.
void	btez2_set_cmd_mode (btez2_t *ctx)
	BT-EZ 2 set cmd mode function.
void	btez2_set_data_mode (btez2_t *ctx)
	BT-EZ 2 set data mode function.
void	btez2_cmd_action (btez2_t *ctx, uint8_t *cmd, uint8_t *params)
	BT-EZ 2 cmd action function.
void	btez2_cmd_set (btez2_t *ctx, uint8_t *cmd, uint8_t *params)
	BT-EZ 2 cmd set function.
void	btez2_cmd_get (btez2_t *ctx, uint8_t *cmd, uint8_t *params)
	BT-EZ 2 cmd get function.
void	btez2_cmd_profile (btez2_t *ctx, uint8_t *cmd, uint8_t *params)
	BT-EZ 2 cmd profile function.
err_t	btez2_read_packet (btez2_t *ctx)
	BT-EZ 2 read packet function.

Detailed Description

This file contains API for BT-EZ 2 Click Driver.

Enumeration Type Documentation

btez2_return_value_t

enum btez2_return_value_t

BT-EZ 2 Click return value data.

Predefined enum values for driver return values.

Enumerator
BTEZ2_OK
BTEZ2_ERROR
BTEZ2_ERROR_TIMEOUT
BTEZ2_ERROR_CMD